Livealert Quick Reference Guide


Command Description Recommended Frequency
livealert/listDatapoints/1 Use this to see our entire list of datapoints. Once every 12 hours to checkfor new datapoints
livealert/datapoint/1 For each datapoint you want to map, you should invoke the datapoint command to see the possible answers. Once every 12 hours to checkfor changes to datapoints
livealert/inventory/1 This API is used to list all of the available surveys. No longer than once every 10minutes. If the lastModified field is more recent than the last time you made the call for a survey, you should call the targeting command for that survey.
livealert/targeting/1 For each survey that you want to target, you should invoke the targeting command to see the qualifiers needed for that survey You will only need to make this call for a particular survey again if the "lastModified" field mentioned above has changed.
livealert/createLink/1 Creates a link for the survey. You can use this link for all users, just append all the mandatory parameters mentioned below and any other information you have about each user, relevant to this project You will only need to do this once per survey. The entry link will never change for a survey.
livealert/duplicateCheck/1 This API is used to determine if a respondent is likely to be rejected from a survey because of our deduplication criteria. Make this API call the moment before you display the survey tothe user.
livealert/log/1 This API is used to obtain the logs of the individual starts on surveys. You can use this at a frequency of your choosing
livealert/stats/1 This API is used to obtain the latest statistics on survey performance. You can use this at a frequency of your choosing